<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>HibernateGenericDao xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/hibernate/HibernateGenericDao.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*****************************************************************************</em></em>
<a name="2" href="#2">2</a>   <em> * HibernateGenericDaoImpl.java - created by aaronz@vt.edu</em>
<a name="3" href="#3">3</a>   <em> * </em>
<a name="4" href="#4">4</a>   <em> * Copyright (c) 2006 Aaron Zeckoski</em>
<a name="5" href="#5">5</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="6" href="#6">6</a>   <em> * </em>
<a name="7" href="#7">7</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="8" href="#8">8</a>   <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="9" href="#9">9</a>   <em> * </em>
<a name="10" href="#10">10</a>  <em> * Contributors:</em>
<a name="11" href="#11">11</a>  <em> * Aaron Zeckoski (aaronz@vt.edu) - Project Lead</em>
<a name="12" href="#12">12</a>  <em> * </em>
<a name="13" href="#13">13</a>  <em> *****************************************************************************/</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.hibernate;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.Serializable;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.ArrayList;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.Iterator;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.List;
<a name="21" href="#21">21</a>  <strong>import</strong> java.util.Map;
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.Map.Entry;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.concurrent.ConcurrentHashMap;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  <strong>import</strong> org.azeckoski.reflectutils.ClassLoaderUtils;
<a name="26" href="#26">26</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="27" href="#27">27</a>  <strong>import</strong> org.hibernate.EntityMode;
<a name="28" href="#28">28</a>  <strong>import</strong> org.hibernate.Hibernate;
<a name="29" href="#29">29</a>  <strong>import</strong> org.hibernate.HibernateException;
<a name="30" href="#30">30</a>  <strong>import</strong> org.hibernate.Query;
<a name="31" href="#31">31</a>  <strong>import</strong> org.hibernate.metadata.ClassMetadata;
<a name="32" href="#32">32</a>  <strong>import</strong> org.sakaiproject.genericdao.api.GenericDao;
<a name="33" href="#33">33</a>  <strong>import</strong> org.sakaiproject.genericdao.api.caching.CacheProvider;
<a name="34" href="#34">34</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.DaoOperationInterceptor;
<a name="35" href="#35">35</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.ReadInterceptor;
<a name="36" href="#36">36</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.WriteInterceptor;
<a name="37" href="#37">37</a>  <strong>import</strong> org.sakaiproject.genericdao.api.search.Restriction;
<a name="38" href="#38">38</a>  <strong>import</strong> org.sakaiproject.genericdao.api.search.Search;
<a name="39" href="#39">39</a>  <strong>import</strong> org.sakaiproject.genericdao.base.caching.NonCachingCacheProvider;
<a name="40" href="#40">40</a>  <strong>import</strong> org.springframework.orm.hibernate3.HibernateObjectRetrievalFailureException;
<a name="41" href="#41">41</a>  <strong>import</strong> org.springframework.orm.hibernate3.support.HibernateDaoSupport;
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>  <em>/**<em>*</em></em>
<a name="44" href="#44">44</a>  <em> * A Hibernate (<a href="http://hibernate.org/)" target="alexandria_uri">http://hibernate.org/)</a> based implementation of GenericDao</em>
<a name="45" href="#45">45</a>  <em> * which can be extended to add more specialized DAO methods.</em>
<a name="46" href="#46">46</a>  <em> * &lt;p></em>
<a name="47" href="#47">47</a>  <em> * Note: This implementation is so simple it is unlikely to be useful</em>
<a name="48" href="#48">48</a>  <em> * &lt;p></em>
<a name="49" href="#49">49</a>  <em> * See the overview for installation/usage tips.</em>
<a name="50" href="#50">50</a>  <em> * </em>
<a name="51" href="#51">51</a>  <em> * @author Aaron Zeckoski (aaronz@vt.edu)</em>
<a name="52" href="#52">52</a>  <em> */</em>
<a name="53" href="#53">53</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/genericdao/hibernate/HibernateGenericDao.html">HibernateGenericDao</a> <strong>extends</strong> HibernateDaoSupport implements <a href="../../../../org/sakaiproject/genericdao/api/GenericDao.html">GenericDao</a> {
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>     <strong>protected</strong> <strong>static</strong> String COUNTALL_QUERY = <span class="string">"select count(*) "</span>;
<a name="56" href="#56">56</a>     <strong>protected</strong> <strong>static</strong> String START_QUERY = <span class="string">"from"</span>;
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>     <em>/**<em>*</em></em>
<a name="59" href="#59">59</a>  <em>    * Set the list of persistent classes that this DAO will handle&lt;br/></em>
<a name="60" href="#60">60</a>  <em>    * This no longer requires this to be set before the class initializes</em>
<a name="61" href="#61">61</a>  <em>    * Do this using Spring like so:</em>
<a name="62" href="#62">62</a>  <em>    * &lt;xmp></em>
<a name="63" href="#63">63</a>  <em>      &lt;property name="persistentClasses"></em>
<a name="64" href="#64">64</a>  <em>         &lt;list></em>
<a name="65" href="#65">65</a>  <em>            &lt;value>org.sakaiproject.*yourappname*.model.*YourObject*&lt;/value></em>
<a name="66" href="#66">66</a>  <em>         &lt;/list></em>
<a name="67" href="#67">67</a>  <em>      &lt;/property></em>
<a name="68" href="#68">68</a>  <em>    * &lt;/xmp></em>
<a name="69" href="#69">69</a>  <em>    * @param classes a list of Strings representing the</em>
<a name="70" href="#70">70</a>  <em>    * the fully qualified classpath and classname of persistent objects</em>
<a name="71" href="#71">71</a>  <em>    */</em>
<a name="72" href="#72">72</a>     <strong>public</strong> <strong>void</strong> setPersistentClasses(List&lt;String> classes) {
<a name="73" href="#73">73</a>        <strong>if</strong> (classes.size() == 0) {
<a name="74" href="#74">74</a>           <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"persistent class list must have at least one item"</span>);
<a name="75" href="#75">75</a>        }
<a name="76" href="#76">76</a>        List&lt;Class&lt;?>> classList = <strong>new</strong> ArrayList&lt;Class&lt;?>>();
<a name="77" href="#77">77</a>        <strong>for</strong> (Iterator&lt;String> i = classes.iterator(); i.hasNext();) {
<a name="78" href="#78">78</a>           String className = i.next();
<a name="79" href="#79">79</a>           Class&lt;?> c = ClassLoaderUtils.getClassFromString(className);
<a name="80" href="#80">80</a>           <strong>if</strong> (c == <strong>null</strong>) {
<a name="81" href="#81">81</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(
<a name="82" href="#82">82</a>                    <span class="string">"Invalid class type in list of persistent classes: "</span> + className);
<a name="83" href="#83">83</a>           }
<a name="84" href="#84">84</a>           classList.add(c);
<a name="85" href="#85">85</a>        }
<a name="86" href="#86">86</a>        <strong>this</strong>.classes = classList;
<a name="87" href="#87">87</a>     }
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>     <em>/**<em>*</em></em>
<a name="91" href="#91">91</a>  <em>    * Take a list of persistent hibernate objects and return non-persistent clones</em>
<a name="92" href="#92">92</a>  <em>    * @param items a list of persistent objects</em>
<a name="93" href="#93">93</a>  <em>    * @return a list of non-persistent cloned objects</em>
<a name="94" href="#94">94</a>  <em>    */</em>
<a name="95" href="#95">95</a>     <strong>protected</strong> &lt;T> List&lt;T> cloneList(List&lt;T> items) {
<a name="96" href="#96">96</a>        <strong>if</strong> (items.isEmpty()) { <strong>return</strong> items; }
<a name="97" href="#97">97</a>        List&lt;T> clonedItems = <strong>new</strong> ArrayList&lt;T>();
<a name="98" href="#98">98</a>        <strong>for</strong> (T item : items) {
<a name="99" href="#99">99</a>           <em class="comment">// create a clone of each hibernate object and pass back the clone only,</em>
<a name="100" href="#100">100</a>          <em class="comment">// cloning only the bottom level of data</em>
<a name="101" href="#101">101</a>          clonedItems.add( ReflectUtils.getInstance().clone(item, 0, <strong>null</strong>) );
<a name="102" href="#102">102</a>       }
<a name="103" href="#103">103</a>       <strong>return</strong> clonedItems;
<a name="104" href="#104">104</a>    }
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>    <em class="comment">/*</em>
<a name="107" href="#107">107</a> <em class="comment">    * Add some convenience methods here</em>
<a name="108" href="#108">108</a> <em class="comment">    */</em>
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>    <em>/**<em>*</em></em>
<a name="111" href="#111">111</a> <em>    * This is a convenience method that DAO writers can use to do counts using any HQL,</em>
<a name="112" href="#112">112</a> <em>    * it is efficient in that it does not return all objects and only does the count</em>
<a name="113" href="#113">113</a> <em>    * </em>
<a name="114" href="#114">114</a> <em>    * @param hqlQuery any Hibernate HQL query of the format "from Blah..." or "select thing from Blah..."</em>
<a name="115" href="#115">115</a> <em>    * @return the number of items that would have been returned</em>
<a name="116" href="#116">116</a> <em>    */</em>
<a name="117" href="#117">117</a>    <strong>protected</strong> <strong>int</strong> count(String hqlQuery) {
<a name="118" href="#118">118</a>       String newHqlQuery = buildCountHQL(hqlQuery);
<a name="119" href="#119">119</a>       <strong>return</strong> ((Number) getHibernateTemplate().iterate(newHqlQuery).next()).intValue();
<a name="120" href="#120">120</a>    }
<a name="121" href="#121">121</a> 
<a name="122" href="#122">122</a>    <em>/**<em>*</em></em>
<a name="123" href="#123">123</a> <em>    * This is a convenience method that DAO writers can use to do counts using any HQL,</em>
<a name="124" href="#124">124</a> <em>    * it is efficient in that it does not return all objects and only does the count</em>
<a name="125" href="#125">125</a> <em>    * </em>
<a name="126" href="#126">126</a> <em>    * @param hqlQuery any Hibernate HQL query of the format "from Blah..." or "select thing from Blah..."</em>
<a name="127" href="#127">127</a> <em>    * @param params an array of values which are represented as "?" in the hql</em>
<a name="128" href="#128">128</a> <em>    * @return the number of items that would have been returned</em>
<a name="129" href="#129">129</a> <em>    */</em>
<a name="130" href="#130">130</a>    <strong>protected</strong> <strong>int</strong> count(String hqlQuery, Object[] params) {
<a name="131" href="#131">131</a>       String newHqlQuery = buildCountHQL(hqlQuery);
<a name="132" href="#132">132</a>       <strong>return</strong> ((Number) getHibernateTemplate().iterate(newHqlQuery, params).next()).intValue();
<a name="133" href="#133">133</a>    }
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>    <em>/**<em>*</em></em>
<a name="136" href="#136">136</a> <em>    * Builds count HQL from an HQL query</em>
<a name="137" href="#137">137</a> <em>    * </em>
<a name="138" href="#138">138</a> <em>    * @param hqlQuery an hql query</em>
<a name="139" href="#139">139</a> <em>    * @return the HQL to do a count</em>
<a name="140" href="#140">140</a> <em>    */</em>
<a name="141" href="#141">141</a>    <strong>private</strong> String buildCountHQL(String hqlQuery) {
<a name="142" href="#142">142</a>       <strong>if</strong> (hqlQuery == <strong>null</strong>) {
<a name="143" href="#143">143</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"hqlQuery cannot be null"</span>);
<a name="144" href="#144">144</a>       }
<a name="145" href="#145">145</a>       hqlQuery = hqlQuery.trim();
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>       <em class="comment">// clean HQL up in case it looks like this: select blah from Blah</em>
<a name="148" href="#148">148</a>       <strong>int</strong> fromLoc = hqlQuery.indexOf(START_QUERY);
<a name="149" href="#149">149</a>       <strong>if</strong> (fromLoc == -1) {
<a name="150" href="#150">150</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"HQL appears to be invalid: "</span>
<a name="151" href="#151">151</a>                + <span class="string">"query does not start with the string: "</span> + START_QUERY);
<a name="152" href="#152">152</a>       }
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>       <em class="comment">// get rid of the sort by since this will cause the count query to fail</em>
<a name="155" href="#155">155</a>       <strong>int</strong> sortLoc = hqlQuery.indexOf(<span class="string">"sort by"</span>);
<a name="156" href="#156">156</a>       <strong>if</strong> (sortLoc == -1) { sortLoc = hqlQuery.length(); }
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>       String newHqlQuery = hqlQuery.substring(fromLoc, sortLoc);
<a name="160" href="#160">160</a>       <strong>if</strong> (fromLoc == 0) {
<a name="161" href="#161">161</a>          newHqlQuery = COUNTALL_QUERY + newHqlQuery;
<a name="162" href="#162">162</a>       } <strong>else</strong> {
<a name="163" href="#163">163</a>          <em class="comment">// make sure we keep the "blah" part and just put count() around it: select count(blah) from Blah</em>
<a name="164" href="#164">164</a>          String oldPrefix = hqlQuery.substring(0, fromLoc);
<a name="165" href="#165">165</a>          String[] parts = oldPrefix.split(<span class="string">" "</span>);
<a name="166" href="#166">166</a>          <strong>if</strong> (parts.length > 1) {
<a name="167" href="#167">167</a>             String prefix = <span class="string">"select count("</span> + parts[1] + <span class="string">") "</span>;
<a name="168" href="#168">168</a>             newHqlQuery = prefix + newHqlQuery;
<a name="169" href="#169">169</a>          }
<a name="170" href="#170">170</a>       }
<a name="171" href="#171">171</a>       <strong>return</strong> newHqlQuery;
<a name="172" href="#172">172</a>    }
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a> 
<a name="175" href="#175">175</a>    <em>/**<em>*</em></em>
<a name="176" href="#176">176</a> <em>    * Generates the HQL snippet needed to represent this property/comparison/value triple,</em>
<a name="177" href="#177">177</a> <em>    * will turn the value into a string, use {@link #makeComparisonHQL(Map, String, int, Object)}</em>
<a name="178" href="#178">178</a> <em>    * if you want to deliver the object directly</em>
<a name="179" href="#179">179</a> <em>    * </em>
<a name="180" href="#180">180</a> <em>    * @param property the name of the entity property</em>
<a name="181" href="#181">181</a> <em>    * @param comparisonConstant the comparison constant (e.g. EQUALS)</em>
<a name="182" href="#182">182</a> <em>    * @param value the value to compare the property to</em>
<a name="183" href="#183">183</a> <em>    * @return a string representing the HQL snippet (e.g. propA = 'apple')</em>
<a name="184" href="#184">184</a> <em>    */</em>
<a name="185" href="#185">185</a>    <strong>protected</strong> String makeComparisonHQL(String property, <strong>int</strong> comparisonConstant, Object value) {
<a name="186" href="#186">186</a>       String sval = <strong>null</strong>;
<a name="187" href="#187">187</a>       <strong>if</strong> (comparisonConstant != Restriction.NOT_NULL &amp;&amp; comparisonConstant != Restriction.NULL) {
<a name="188" href="#188">188</a>          <strong>if</strong> (value.getClass().isAssignableFrom(Boolean.<strong>class</strong>) 
<a name="189" href="#189">189</a>                || value.getClass().isAssignableFrom(Number.<strong>class</strong>)) {
<a name="190" href="#190">190</a>             <em class="comment">// special handling for boolean and numbers</em>
<a name="191" href="#191">191</a>             sval = value.toString();
<a name="192" href="#192">192</a>          } <strong>else</strong> {
<a name="193" href="#193">193</a>             sval = <span class="string">"'"</span> + value.toString() + <span class="string">"'"</span>;
<a name="194" href="#194">194</a>          }
<a name="195" href="#195">195</a>       }
<a name="196" href="#196">196</a>       <strong>return</strong> buildComparisonHQL(property, comparisonConstant, sval);
<a name="197" href="#197">197</a>    }
<a name="198" href="#198">198</a> 
<a name="199" href="#199">199</a>    <em>/**<em>*</em></em>
<a name="200" href="#200">200</a> <em>    * @param params a set of params to add this value to</em>
<a name="201" href="#201">201</a> <em>    * @param property the name of the entity property</em>
<a name="202" href="#202">202</a> <em>    * @param comparisonConstant the comparison constant (e.g. EQUALS)</em>
<a name="203" href="#203">203</a> <em>    * @param value the value to compare the property to</em>
<a name="204" href="#204">204</a> <em>    * @return a string representing the HQL snippet (e.g. propA = :propA)</em>
<a name="205" href="#205">205</a> <em>    */</em>
<a name="206" href="#206">206</a>    <strong>protected</strong> String makeComparisonHQL(Map&lt;String, Object> params, String property, <strong>int</strong> comparisonConstant, Object value) {
<a name="207" href="#207">207</a>       <strong>if</strong> (comparisonConstant != Restriction.NOT_NULL &amp;&amp; comparisonConstant != Restriction.NULL) {
<a name="208" href="#208">208</a>          params.put(property, value);
<a name="209" href="#209">209</a>       }
<a name="210" href="#210">210</a>       <strong>return</strong> buildComparisonHQL(property, comparisonConstant, <span class="string">":"</span> + property);
<a name="211" href="#211">211</a>    }
<a name="212" href="#212">212</a> 
<a name="213" href="#213">213</a>    <em>/**<em>*</em></em>
<a name="214" href="#214">214</a> <em>    * @param property</em>
<a name="215" href="#215">215</a> <em>    * @param comparisonConstant</em>
<a name="216" href="#216">216</a> <em>    * @param sval</em>
<a name="217" href="#217">217</a> <em>    * @return</em>
<a name="218" href="#218">218</a> <em>    */</em>
<a name="219" href="#219">219</a>    <strong>private</strong> String buildComparisonHQL(String property, <strong>int</strong> comparisonConstant, String sval) {
<a name="220" href="#220">220</a>       <strong>switch</strong> (comparisonConstant) {
<a name="221" href="#221">221</a>       <strong>case</strong> Restriction.EQUALS:      <strong>return</strong> property + <span class="string">" = "</span> + sval;
<a name="222" href="#222">222</a>       <strong>case</strong> Restriction.GREATER:     <strong>return</strong> property + <span class="string">" > "</span> + sval;
<a name="223" href="#223">223</a>       <strong>case</strong> Restriction.LESS:        <strong>return</strong> property + <span class="string">" &lt; "</span> + sval;
<a name="224" href="#224">224</a>       <strong>case</strong> Restriction.LIKE:        <strong>return</strong> property + <span class="string">" like "</span> + sval;
<a name="225" href="#225">225</a>       <strong>case</strong> Restriction.NOT_EQUALS:  <strong>return</strong> property + <span class="string">" &lt;> "</span> + sval;
<a name="226" href="#226">226</a>       <strong>case</strong> Restriction.NOT_NULL:    <strong>return</strong> property + <span class="string">" is not null"</span>;
<a name="227" href="#227">227</a>       <strong>case</strong> Restriction.NULL:        <strong>return</strong> property + <span class="string">" is null"</span>;
<a name="228" href="#228">228</a>       <strong>default</strong>: <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid comparison constant: "</span> + comparisonConstant);
<a name="229" href="#229">229</a>       }
<a name="230" href="#230">230</a>    }
<a name="231" href="#231">231</a> 
<a name="232" href="#232">232</a> 
<a name="233" href="#233">233</a>    <em>/**<em>*</em></em>
<a name="234" href="#234">234</a> <em>    * Provides an easy way to execute an HQL query with ? params</em>
<a name="235" href="#235">235</a> <em>    * </em>
<a name="236" href="#236">236</a> <em>    * @param hql a hibernate query language query</em>
<a name="237" href="#237">237</a> <em>    * @param params an array of values (you should have "?" in your HQL whereever the values will be inserted)</em>
<a name="238" href="#238">238</a> <em>    * @param start the entry number to start on (based on current sort rules), first entry is 0</em>
<a name="239" href="#239">239</a> <em>    * @param limit the maximum number of entries to return, 0 returns as many entries as possible</em>
<a name="240" href="#240">240</a> <em>    * @return a list of whatever you requested in the HQL</em>
<a name="241" href="#241">241</a> <em>    */</em>
<a name="242" href="#242">242</a>    <strong>protected</strong> List&lt;?> executeHqlQuery(String hql, Object[] params, <strong>int</strong> start, <strong>int</strong> limit) {
<a name="243" href="#243">243</a>       Query query = getSession().createQuery(hql);
<a name="244" href="#244">244</a>       query.setFirstResult(start);
<a name="245" href="#245">245</a>       <strong>if</strong> (limit > 0) {
<a name="246" href="#246">246</a>          query.setMaxResults(limit);
<a name="247" href="#247">247</a>       }
<a name="248" href="#248">248</a>       <strong>for</strong> (<strong>int</strong> i = 0; i &lt; params.length; i++) {
<a name="249" href="#249">249</a>          query.setParameter(i, params[i]);
<a name="250" href="#250">250</a>       }
<a name="251" href="#251">251</a>       <strong>return</strong> query.list();
<a name="252" href="#252">252</a>    }
<a name="253" href="#253">253</a> 
<a name="254" href="#254">254</a>    <em>/**<em>*</em></em>
<a name="255" href="#255">255</a> <em>    * Provides an easy way to execute an HQL query with named parameters</em>
<a name="256" href="#256">256</a> <em>    * </em>
<a name="257" href="#257">257</a> <em>    * @param hql a hibernate query language query</em>
<a name="258" href="#258">258</a> <em>    * @param params the map of named parameters</em>
<a name="259" href="#259">259</a> <em>    * @param start the entry number to start on (based on current sort rules), first entry is 0</em>
<a name="260" href="#260">260</a> <em>    * @param limit the maximum number of entries to return, 0 returns as many entries as possible</em>
<a name="261" href="#261">261</a> <em>    * @return a list of whatever you requested in the HQL</em>
<a name="262" href="#262">262</a> <em>    */</em>
<a name="263" href="#263">263</a>    <strong>protected</strong> List&lt;?> executeHqlQuery(String hql, Map&lt;String, Object> params, <strong>int</strong> start, <strong>int</strong> limit) {
<a name="264" href="#264">264</a>       Query query = getSession().createQuery(hql);
<a name="265" href="#265">265</a>       query.setFirstResult(start);
<a name="266" href="#266">266</a>       <strong>if</strong> (limit > 0) {
<a name="267" href="#267">267</a>          query.setMaxResults(limit);
<a name="268" href="#268">268</a>       }
<a name="269" href="#269">269</a>       setParameters(query, params);
<a name="270" href="#270">270</a>       <strong>return</strong> query.list();
<a name="271" href="#271">271</a>    }
<a name="272" href="#272">272</a> 
<a name="273" href="#273">273</a>    <em>/**<em>*</em></em>
<a name="274" href="#274">274</a> <em>    * This is supported natively in Hibernate 3.2.x and up&lt;br/></em>
<a name="275" href="#275">275</a> <em>    * sets the parameters correctly for hibernate 3.1</em>
<a name="276" href="#276">276</a> <em>    * </em>
<a name="277" href="#277">277</a> <em>    * @param query</em>
<a name="278" href="#278">278</a> <em>    * @param params</em>
<a name="279" href="#279">279</a> <em>    */</em>
<a name="280" href="#280">280</a>    <strong>protected</strong> <strong>void</strong> setParameters(Query query, Map&lt;String, Object> params) {
<a name="281" href="#281">281</a>       <strong>for</strong> (Entry&lt;String, Object> entry : params.entrySet()) {
<a name="282" href="#282">282</a>          String name = entry.getKey();
<a name="283" href="#283">283</a>          Object param = entry.getValue();
<a name="284" href="#284">284</a>          <strong>if</strong> (param.getClass().isArray()) {
<a name="285" href="#285">285</a>             query.setParameterList(name, (Object[]) param);
<a name="286" href="#286">286</a>          } <strong>else</strong> {
<a name="287" href="#287">287</a>             query.setParameter(name, param);
<a name="288" href="#288">288</a>          }
<a name="289" href="#289">289</a>       }
<a name="290" href="#290">290</a>    }
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a> 
<a name="293" href="#293">293</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="294" href="#294">294</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.GenericDao#getIdProperty(java.lang.Class)</em>
<a name="295" href="#295">295</a> <em class="comment">    */</em>
<a name="296" href="#296">296</a>    <strong>public</strong> String getIdProperty(Class&lt;?> entityClass) {
<a name="297" href="#297">297</a>       ClassMetadata classmeta = getSessionFactory().getClassMetadata(entityClass);
<a name="298" href="#298">298</a>       <strong>if</strong> (classmeta == <strong>null</strong>) <strong>return</strong> <strong>null</strong>;
<a name="299" href="#299">299</a>       <strong>return</strong> classmeta.getIdentifierPropertyName();
<a name="300" href="#300">300</a>    }
<a name="301" href="#301">301</a> 
<a name="302" href="#302">302</a>    <em class="comment">// OVERRIDES</em>
<a name="303" href="#303">303</a> 
<a name="304" href="#304">304</a>    <em>/**<em>*</em></em>
<a name="305" href="#305">305</a> <em>    * Use hibernate metadata to get the id value</em>
<a name="306" href="#306">306</a> <em>    */</em>
<a name="307" href="#307">307</a>    <strong>protected</strong> Serializable baseGetIdValue(Object object) {
<a name="308" href="#308">308</a>       Class&lt;?> type = findClass(object);
<a name="309" href="#309">309</a>       Serializable idValue = <strong>null</strong>;
<a name="310" href="#310">310</a>       ClassMetadata classmeta = getSessionFactory().getClassMetadata(type);
<a name="311" href="#311">311</a>       <strong>if</strong> (classmeta != <strong>null</strong>) {
<a name="312" href="#312">312</a>          <strong>if</strong> (classmeta.hasIdent<strong>if</strong>ierProperty()) {
<a name="313" href="#313">313</a>             idValue = classmeta.getIdentifier(object, EntityMode.POJO);
<a name="314" href="#314">314</a>          }
<a name="315" href="#315">315</a>       } <strong>else</strong> {
<a name="316" href="#316">316</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not get classmetadata for this object, it may not be persistent: "</span> + object);
<a name="317" href="#317">317</a>       }
<a name="318" href="#318">318</a>       <strong>return</strong> idValue;
<a name="319" href="#319">319</a>    }
<a name="320" href="#320">320</a> 
<a name="321" href="#321">321</a>    <em>/**<em>*</em></em>
<a name="322" href="#322">322</a> <em>    * MUST be overridden</em>
<a name="323" href="#323">323</a> <em>    */</em>
<a name="324" href="#324">324</a>    @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="325" href="#325">325</a>    <strong>protected</strong> &lt;T> T baseFindById(Class&lt;T> type, Serializable id) {
<a name="326" href="#326">326</a>       T entity = <strong>null</strong>;
<a name="327" href="#327">327</a>       <strong>try</strong> {
<a name="328" href="#328">328</a>          entity = (T) getHibernateTemplate().get(type, id);
<a name="329" href="#329">329</a>       } <strong>catch</strong> (HibernateObjectRetrievalFailureException e) {
<a name="330" href="#330">330</a>          <em class="comment">// TODO - maybe log an error here or take this out later</em>
<a name="331" href="#331">331</a>          <em class="comment">// if they fix the get to not throw a nasty error</em>
<a name="332" href="#332">332</a>          entity = <strong>null</strong>;
<a name="333" href="#333">333</a>       }
<a name="334" href="#334">334</a>       <strong>return</strong> entity;
<a name="335" href="#335">335</a>    }
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>    <em>/**<em>*</em></em>
<a name="338" href="#338">338</a> <em>    * MUST be overridden</em>
<a name="339" href="#339">339</a> <em>    */</em>
<a name="340" href="#340">340</a>    <strong>protected</strong> Serializable baseCreate(Class&lt;?> type, Object object) {
<a name="341" href="#341">341</a>       <em class="comment">// this ugly but hibernate will save an object which is already persistent so we have to do this check up front</em>
<a name="342" href="#342">342</a>       Serializable id;
<a name="343" href="#343">343</a>       <strong>try</strong> {
<a name="344" href="#344">344</a>          id = getSession().getIdentifier(object);
<a name="345" href="#345">345</a>       } <strong>catch</strong> (HibernateException e) {
<a name="346" href="#346">346</a>          id = <strong>null</strong>;
<a name="347" href="#347">347</a>       }
<a name="348" href="#348">348</a>       <strong>if</strong> (id != <strong>null</strong>) {
<a name="349" href="#349">349</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"This object is already persistent with id: "</span> + id 
<a name="350" href="#350">350</a>                + <span class="string">" - you must use update to save this object and not create"</span>);
<a name="351" href="#351">351</a>       }
<a name="352" href="#352">352</a>       id = getHibernateTemplate().save(object);
<a name="353" href="#353">353</a>       <strong>return</strong> id;
<a name="354" href="#354">354</a>    }
<a name="355" href="#355">355</a> 
<a name="356" href="#356">356</a>    <em>/**<em>*</em></em>
<a name="357" href="#357">357</a> <em>    * MUST be overridden</em>
<a name="358" href="#358">358</a> <em>    */</em>
<a name="359" href="#359">359</a>    <strong>protected</strong> <strong>void</strong> baseUpdate(Class&lt;?> type, Object id, Object object) {
<a name="360" href="#360">360</a>       getHibernateTemplate().update(object);
<a name="361" href="#361">361</a>    }
<a name="362" href="#362">362</a> 
<a name="363" href="#363">363</a>    <em>/**<em>*</em></em>
<a name="364" href="#364">364</a> <em>    * MUST be overridden</em>
<a name="365" href="#365">365</a> <em>    */</em>
<a name="366" href="#366">366</a>    <strong>protected</strong> &lt;T> <strong>boolean</strong> baseDelete(Class&lt;T> type, Serializable id) {
<a name="367" href="#367">367</a>       <strong>boolean</strong> deleted = false;
<a name="368" href="#368">368</a>       Object object = baseFindById(type, id);
<a name="369" href="#369">369</a>       <strong>if</strong> (object != <strong>null</strong>) {
<a name="370" href="#370">370</a>          getHibernateTemplate().delete(object);
<a name="371" href="#371">371</a>          deleted = <strong>true</strong>;
<a name="372" href="#372">372</a>       }
<a name="373" href="#373">373</a>       <strong>return</strong> deleted;
<a name="374" href="#374">374</a> <em>/**<em>* This will not flush the item from the session so it is hopeless -AZ</em></em>
<a name="375" href="#375">375</a> <em>      String query = "delete from " + type.getName() + " where " </em>
<a name="376" href="#376">376</a> <em>            + getIdProperty(type) + "= ?";</em>
<a name="377" href="#377">377</a> <em>      int i = getHibernateTemplate().bulkUpdate(query, id);</em>
<a name="378" href="#378">378</a> <em>      boolean deleted = false;</em>
<a name="379" href="#379">379</a> <em>      if (i > 0) {</em>
<a name="380" href="#380">380</a> <em>         getSessionFactory().evict(type, id); //evict this item from the cache</em>
<a name="381" href="#381">381</a> <em>         deleted = true;</em>
<a name="382" href="#382">382</a> <em>      }</em>
<a name="383" href="#383">383</a> <em>      return deleted;</em>
<a name="384" href="#384">384</a> <em>**/</em>
<a name="385" href="#385">385</a>    }
<a name="386" href="#386">386</a> 
<a name="387" href="#387">387</a>    <em>/**<em>*</em></em>
<a name="388" href="#388">388</a> <em>    * Find the class type of a persistent object,</em>
<a name="389" href="#389">389</a> <em>    * needed in the case that we are working with something that wraps it's objects&lt;br/></em>
<a name="390" href="#390">390</a> <em>    * Override this if desired</em>
<a name="391" href="#391">391</a> <em>    * @param entity a persistent entity</em>
<a name="392" href="#392">392</a> <em>    * @return the persistent class type OR null if it cannot be found</em>
<a name="393" href="#393">393</a> <em>    */</em>
<a name="394" href="#394">394</a>    <strong>protected</strong> Class&lt;?> findClass(Object entity) {
<a name="395" href="#395">395</a>       <strong>if</strong> (entity == <strong>null</strong>) {
<a name="396" href="#396">396</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot find class type of null entity object"</span>);
<a name="397" href="#397">397</a>       }
<a name="398" href="#398">398</a>       Class&lt;?> type = Hibernate.getClass(entity);
<a name="399" href="#399">399</a>       <strong>return</strong> type;
<a name="400" href="#400">400</a>    }
<a name="401" href="#401">401</a> 
<a name="402" href="#402">402</a>    <em class="comment">// COMMON CODE</em>
<a name="403" href="#403">403</a> 
<a name="404" href="#404">404</a>    <strong>private</strong> List&lt;Class&lt;?>> classes;
<a name="405" href="#405">405</a>    <em>/**<em>*</em></em>
<a name="406" href="#406">406</a> <em>    * This does a nice bit of exception handling for us and verifies that</em>
<a name="407" href="#407">407</a> <em>    * this class is valid to perform a DAO operation with</em>
<a name="408" href="#408">408</a> <em>    * @param type class type of the persistent object to check</em>
<a name="409" href="#409">409</a> <em>    * @return A valid entityClass type resolved to be the same as</em>
<a name="410" href="#410">410</a> <em>    * the ones usable by this DAO</em>
<a name="411" href="#411">411</a> <em>    */</em>
<a name="412" href="#412">412</a>    <strong>protected</strong> Class&lt;?> checkClass(Class&lt;?> type) {
<a name="413" href="#413">413</a>       <strong>if</strong> (type == <strong>null</strong>) {
<a name="414" href="#414">414</a>          <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"type cannot be null"</span>);
<a name="415" href="#415">415</a>       }
<a name="416" href="#416">416</a> 
<a name="417" href="#417">417</a>       <strong>if</strong> (classes == <strong>null</strong>) {
<a name="418" href="#418">418</a>          <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"persistent classes must be set"</span>);
<a name="419" href="#419">419</a>       }
<a name="420" href="#420">420</a> 
<a name="421" href="#421">421</a>       <strong>for</strong> (Iterator&lt;Class&lt;?>> i = classes.iterator(); i.hasNext();) {
<a name="422" href="#422">422</a>          Class&lt;?> concrete = (Class&lt;?>) i.next();
<a name="423" href="#423">423</a>          <strong>if</strong> (concrete.isAssignableFrom(type)) {
<a name="424" href="#424">424</a>             <strong>return</strong> concrete;
<a name="425" href="#425">425</a>          }
<a name="426" href="#426">426</a>       }
<a name="427" href="#427">427</a>       <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not resolve this class "</span> + 
<a name="428" href="#428">428</a>             type + <span class="string">" as part of the set of persistent objects: "</span> +
<a name="429" href="#429">429</a>             classes.toString());
<a name="430" href="#430">430</a>    }
<a name="431" href="#431">431</a> 
<a name="432" href="#432">432</a>    <strong>private</strong> <a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> cacheProvider;
<a name="433" href="#433">433</a>    <em>/**<em>*</em></em>
<a name="434" href="#434">434</a> <em>    * @return the current cache provider</em>
<a name="435" href="#435">435</a> <em>    */</em>
<a name="436" href="#436">436</a>    <strong>protected</strong> <a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> getCacheProvider() {
<a name="437" href="#437">437</a>       <strong>if</strong> (cacheProvider == <strong>null</strong>) {
<a name="438" href="#438">438</a>          cacheProvider = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/base/caching/NonCachingCacheProvider.html">NonCachingCacheProvider</a>();
<a name="439" href="#439">439</a>       }
<a name="440" href="#440">440</a>       <strong>return</strong> cacheProvider;
<a name="441" href="#441">441</a>    }
<a name="442" href="#442">442</a>    <em>/**<em>*</em></em>
<a name="443" href="#443">443</a> <em>    * Set the cache provider to an implementation of {@link CacheProvider},</em>
<a name="444" href="#444">444</a> <em>    * this will be set to {@link NonCachingCacheProvider} if this is not set explicitly</em>
<a name="445" href="#445">445</a> <em>    * @param cacheProvider</em>
<a name="446" href="#446">446</a> <em>    */</em>
<a name="447" href="#447">447</a>    <strong>public</strong> <strong>void</strong> setCacheProvider(<a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> cacheProvider) {
<a name="448" href="#448">448</a>       <strong>this</strong>.cacheProvider = cacheProvider;
<a name="449" href="#449">449</a>    }
<a name="450" href="#450">450</a>    <em>/**<em>*</em></em>
<a name="451" href="#451">451</a> <em>    * @return the cache name used for storing this type of persistent object</em>
<a name="452" href="#452">452</a> <em>    */</em>
<a name="453" href="#453">453</a>    <strong>protected</strong> String getCacheName(Class&lt;?> type) {
<a name="454" href="#454">454</a>       <strong>if</strong> (type == <strong>null</strong>) {
<a name="455" href="#455">455</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type cannot be null"</span>);
<a name="456" href="#456">456</a>       }
<a name="457" href="#457">457</a>       <strong>return</strong> type.getName();
<a name="458" href="#458">458</a>    }
<a name="459" href="#459">459</a>    <em>/**<em>*</em></em>
<a name="460" href="#460">460</a> <em>    * @return the cachename used for storing search results for this type of object</em>
<a name="461" href="#461">461</a> <em>    */</em>
<a name="462" href="#462">462</a>    <strong>protected</strong> String getSearchCacheName(Class&lt;?> type) {
<a name="463" href="#463">463</a>       <strong>if</strong> (type == <strong>null</strong>) {
<a name="464" href="#464">464</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type cannot be null"</span>);
<a name="465" href="#465">465</a>       }
<a name="466" href="#466">466</a>       <strong>return</strong> <span class="string">"search:"</span> + type.getName();
<a name="467" href="#467">467</a>    }
<a name="468" href="#468">468</a>    <em>/**<em>*</em></em>
<a name="469" href="#469">469</a> <em>    * Creates all the caches for the current set of persistent types,</em>
<a name="470" href="#470">470</a> <em>    * this should be called in the init for the generic dao being used after persistent classes are loaded</em>
<a name="471" href="#471">471</a> <em>    */</em>
<a name="472" href="#472">472</a>    <strong>protected</strong> <strong>void</strong> initCaches() {
<a name="473" href="#473">473</a>       <strong>for</strong> (Class&lt;?> type : classes) {
<a name="474" href="#474">474</a>          getCacheProvider().createCache(getCacheName(type));
<a name="475" href="#475">475</a>          getCacheProvider().createCache(getSearchCacheName(type));
<a name="476" href="#476">476</a>       }
<a name="477" href="#477">477</a>    }
<a name="478" href="#478">478</a> 
<a name="479" href="#479">479</a>    <em class="comment">// INTERCEPTOR methods</em>
<a name="480" href="#480">480</a> 
<a name="481" href="#481">481</a>    <strong>private</strong> Map&lt;Class&lt;?>, ReadInterceptor> readInterceptors = <strong>new</strong> ConcurrentHashMap&lt;Class&lt;?>, ReadInterceptor>();
<a name="482" href="#482">482</a>    <strong>private</strong> Map&lt;Class&lt;?>, WriteInterceptor> writeInterceptors = <strong>new</strong> ConcurrentHashMap&lt;Class&lt;?>, WriteInterceptor>();
<a name="483" href="#483">483</a>    <em>/**<em>*</em></em>
<a name="484" href="#484">484</a> <em>    * Adds the provided interceptor to the current set of interceptors</em>
<a name="485" href="#485">485</a> <em>    * @param interceptor</em>
<a name="486" href="#486">486</a> <em>    */</em>
<a name="487" href="#487">487</a>    <strong>public</strong> <strong>void</strong> addInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="488" href="#488">488</a>       <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="489" href="#489">489</a>          Class&lt;?> type = interceptor.interceptType();
<a name="490" href="#490">490</a>          <strong>if</strong> (type != <strong>null</strong>) {
<a name="491" href="#491">491</a>             <strong>if</strong> (ReadInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="492" href="#492">492</a>                readInterceptors.put(type, (ReadInterceptor) interceptor);
<a name="493" href="#493">493</a>             }
<a name="494" href="#494">494</a>             <strong>if</strong> (WriteInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="495" href="#495">495</a>                writeInterceptors.put(type, (WriteInterceptor) interceptor);
<a name="496" href="#496">496</a>             }
<a name="497" href="#497">497</a>          }
<a name="498" href="#498">498</a>       }
<a name="499" href="#499">499</a>    }
<a name="500" href="#500">500</a>    <em>/**<em>*</em></em>
<a name="501" href="#501">501</a> <em>    * Removes the provided interceptor from the current set of interceptors</em>
<a name="502" href="#502">502</a> <em>    * @param interceptor</em>
<a name="503" href="#503">503</a> <em>    */</em>
<a name="504" href="#504">504</a>    <strong>public</strong> <strong>void</strong> removeInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="505" href="#505">505</a>       <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="506" href="#506">506</a>          Class&lt;?> type = interceptor.interceptType();
<a name="507" href="#507">507</a>          <strong>if</strong> (type != <strong>null</strong>) {
<a name="508" href="#508">508</a>             <strong>if</strong> (ReadInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="509" href="#509">509</a>                readInterceptors.remove(type);
<a name="510" href="#510">510</a>             }
<a name="511" href="#511">511</a>             <strong>if</strong> (WriteInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="512" href="#512">512</a>                writeInterceptors.remove(type);
<a name="513" href="#513">513</a>             }
<a name="514" href="#514">514</a>          }
<a name="515" href="#515">515</a>       }
<a name="516" href="#516">516</a>    }
<a name="517" href="#517">517</a>    <em>/**<em>*</em></em>
<a name="518" href="#518">518</a> <em>    * Makes the given interceptor the only active interceptor,</em>
<a name="519" href="#519">519</a> <em>    * removes all others and adds only this one</em>
<a name="520" href="#520">520</a> <em>    * @param interceptor</em>
<a name="521" href="#521">521</a> <em>    */</em>
<a name="522" href="#522">522</a>    <strong>public</strong> <strong>void</strong> setInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="523" href="#523">523</a>       <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="524" href="#524">524</a>          readInterceptors.clear();
<a name="525" href="#525">525</a>          writeInterceptors.clear();
<a name="526" href="#526">526</a>          addInterceptor(interceptor);
<a name="527" href="#527">527</a>       }
<a name="528" href="#528">528</a>    }
<a name="529" href="#529">529</a> 
<a name="530" href="#530">530</a>    <strong>protected</strong> <strong>void</strong> beforeRead(String operation, Class&lt;?> type, Serializable[] ids, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="531" href="#531">531</a>       <strong>if</strong> (type != <strong>null</strong>) {
<a name="532" href="#532">532</a>          <a href="../../../../org/sakaiproject/genericdao/api/interceptors/ReadInterceptor.html">ReadInterceptor</a> interceptor = readInterceptors.get(type);
<a name="533" href="#533">533</a>          <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="534" href="#534">534</a>             interceptor.beforeRead(operation, ids, search);
<a name="535" href="#535">535</a>          }
<a name="536" href="#536">536</a>       }
<a name="537" href="#537">537</a>    }
<a name="538" href="#538">538</a> 
<a name="539" href="#539">539</a>    <strong>protected</strong> <strong>void</strong> afterRead(String operation, Class&lt;?> type, Serializable[] ids, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search, Object[] entities) {
<a name="540" href="#540">540</a>       <strong>if</strong> (type != <strong>null</strong>) {
<a name="541" href="#541">541</a>          <a href="../../../../org/sakaiproject/genericdao/api/interceptors/ReadInterceptor.html">ReadInterceptor</a> interceptor = readInterceptors.get(type);
<a name="542" href="#542">542</a>          <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="543" href="#543">543</a>             interceptor.afterRead(operation, ids, search, entities);
<a name="544" href="#544">544</a>          }
<a name="545" href="#545">545</a>       }
<a name="546" href="#546">546</a>    }
<a name="547" href="#547">547</a> 
<a name="548" href="#548">548</a>    <strong>protected</strong> <strong>void</strong> beforeWrite(String operation, Class&lt;?> type, Serializable[] ids, Object[] entities) {
<a name="549" href="#549">549</a>       <strong>if</strong> (type != <strong>null</strong>) {
<a name="550" href="#550">550</a>          <a href="../../../../org/sakaiproject/genericdao/api/interceptors/WriteInterceptor.html">WriteInterceptor</a> interceptor = writeInterceptors.get(type);
<a name="551" href="#551">551</a>          <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="552" href="#552">552</a>             interceptor.beforeWrite(operation, ids, entities);
<a name="553" href="#553">553</a>          }
<a name="554" href="#554">554</a>       }
<a name="555" href="#555">555</a>    }
<a name="556" href="#556">556</a> 
<a name="557" href="#557">557</a>    <strong>protected</strong> <strong>void</strong> afterWrite(String operation, Class&lt;?> type, Serializable[] ids, Object[] entities, <strong>int</strong> changes) {
<a name="558" href="#558">558</a>       <strong>if</strong> (type != <strong>null</strong>) {
<a name="559" href="#559">559</a>          <a href="../../../../org/sakaiproject/genericdao/api/interceptors/WriteInterceptor.html">WriteInterceptor</a> interceptor = writeInterceptors.get(type);
<a name="560" href="#560">560</a>          <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="561" href="#561">561</a>             interceptor.afterWrite(operation, ids, entities, changes);
<a name="562" href="#562">562</a>          }
<a name="563" href="#563">563</a>       }
<a name="564" href="#564">564</a>    }
<a name="565" href="#565">565</a> 
<a name="566" href="#566">566</a>    <em class="comment">// ********* PUBLIC methods ****************</em>
<a name="567" href="#567">567</a> 
<a name="568" href="#568">568</a> 
<a name="569" href="#569">569</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="570" href="#570">570</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.GenericDao#getPersistentClasses()</em>
<a name="571" href="#571">571</a> <em class="comment">    */</em>
<a name="572" href="#572">572</a>    <strong>public</strong> List&lt;Class&lt;?>> getPersistentClasses() {
<a name="573" href="#573">573</a>       <strong>return</strong> <strong>new</strong> ArrayList&lt;Class&lt;?>>(classes);
<a name="574" href="#574">574</a>    }
<a name="575" href="#575">575</a> 
<a name="576" href="#576">576</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="577" href="#577">577</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.GenericDao#invokeTransactionalAccess(java.lang.Runnable)</em>
<a name="578" href="#578">578</a> <em class="comment">    */</em>
<a name="579" href="#579">579</a>    <strong>public</strong> <strong>void</strong> invokeTransactionalAccess(Runnable toinvoke) {
<a name="580" href="#580">580</a>       toinvoke.run();
<a name="581" href="#581">581</a>    }
<a name="582" href="#582">582</a> 
<a name="583" href="#583">583</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="584" href="#584">584</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.GenericDao#findById(java.lang.Class, java.io.Serializable)</em>
<a name="585" href="#585">585</a> <em class="comment">    */</em>
<a name="586" href="#586">586</a>    @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="587" href="#587">587</a>    <strong>public</strong> &lt;T> T findById(Class&lt;T> type, Serializable id) {
<a name="588" href="#588">588</a>       checkClass(type);
<a name="589" href="#589">589</a>       <strong>if</strong> (id == <strong>null</strong>) {
<a name="590" href="#590">590</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"id must be set to find persistent object"</span>);
<a name="591" href="#591">591</a>       }
<a name="592" href="#592">592</a> 
<a name="593" href="#593">593</a>       T entity = <strong>null</strong>;
<a name="594" href="#594">594</a>       <em class="comment">// check cache first</em>
<a name="595" href="#595">595</a>       String key = id.toString();
<a name="596" href="#596">596</a>       String cacheName = getCacheName(type);
<a name="597" href="#597">597</a>       <strong>if</strong> (getCacheProvider().exists(cacheName, key)) {
<a name="598" href="#598">598</a>          entity = (T) getCacheProvider().get(cacheName, key);
<a name="599" href="#599">599</a>       } <strong>else</strong> {
<a name="600" href="#600">600</a>          <em class="comment">// not in cache so go to the DB</em>
<a name="601" href="#601">601</a>    
<a name="602" href="#602">602</a>          <em class="comment">// before interceptor</em>
<a name="603" href="#603">603</a>          String operation = <span class="string">"findById"</span>;
<a name="604" href="#604">604</a>          beforeRead(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>);
<a name="605" href="#605">605</a>    
<a name="606" href="#606">606</a>          entity = baseFindById(type, id);
<a name="607" href="#607">607</a>    
<a name="608" href="#608">608</a>          <em class="comment">// now put the item in the cache</em>
<a name="609" href="#609">609</a>          getCacheProvider().put(cacheName, key, entity);
<a name="610" href="#610">610</a>    
<a name="611" href="#611">611</a>          <em class="comment">// after interceptor</em>
<a name="612" href="#612">612</a>          afterRead(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>, <strong>new</strong> Object[] {entity});
<a name="613" href="#613">613</a>       }
<a name="614" href="#614">614</a>       <strong>return</strong> entity;
<a name="615" href="#615">615</a>    }
<a name="616" href="#616">616</a> 
<a name="617" href="#617">617</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="618" href="#618">618</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#create(java.lang.Object)</em>
<a name="619" href="#619">619</a> <em class="comment">    */</em>
<a name="620" href="#620">620</a>    <strong>public</strong> <strong>void</strong> create(Object object) {
<a name="621" href="#621">621</a>       Class&lt;?> type = findClass(object);
<a name="622" href="#622">622</a>       checkClass(type);
<a name="623" href="#623">623</a> 
<a name="624" href="#624">624</a>       String operation = <span class="string">"create"</span>;
<a name="625" href="#625">625</a>       beforeWrite(operation, type, <strong>null</strong>, <strong>new</strong> Object[] {object});
<a name="626" href="#626">626</a> 
<a name="627" href="#627">627</a>       Serializable idValue = baseCreate(type, object);
<a name="628" href="#628">628</a> 
<a name="629" href="#629">629</a>       <em class="comment">// clear the search caches</em>
<a name="630" href="#630">630</a>       getCacheProvider().clear(getSearchCacheName(type));
<a name="631" href="#631">631</a> 
<a name="632" href="#632">632</a>       afterWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object}, 1);
<a name="633" href="#633">633</a>    }
<a name="634" href="#634">634</a> 
<a name="635" href="#635">635</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="636" href="#636">636</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#update(java.lang.Object)</em>
<a name="637" href="#637">637</a> <em class="comment">    */</em>
<a name="638" href="#638">638</a>    <strong>public</strong> <strong>void</strong> update(Object object) {
<a name="639" href="#639">639</a>       Class&lt;?> type = findClass(object);
<a name="640" href="#640">640</a>       checkClass(type);
<a name="641" href="#641">641</a> 
<a name="642" href="#642">642</a>       Serializable idValue = baseGetIdValue(object);
<a name="643" href="#643">643</a>       <strong>if</strong> (idValue == <strong>null</strong>) {
<a name="644" href="#644">644</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not get an id value from the supplied object, cannot update without an id: "</span> + object);
<a name="645" href="#645">645</a>       }
<a name="646" href="#646">646</a> 
<a name="647" href="#647">647</a>       String operation = <span class="string">"update"</span>;
<a name="648" href="#648">648</a>       beforeWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object});
<a name="649" href="#649">649</a> 
<a name="650" href="#650">650</a>       baseUpdate(type, idValue, object);
<a name="651" href="#651">651</a> 
<a name="652" href="#652">652</a>       <em class="comment">// clear the search caches</em>
<a name="653" href="#653">653</a>       getCacheProvider().clear(getSearchCacheName(type));
<a name="654" href="#654">654</a>       <em class="comment">// clear the cache entry since this was updated</em>
<a name="655" href="#655">655</a>       String key = idValue.toString();
<a name="656" href="#656">656</a>       String cacheName = getCacheName(type);
<a name="657" href="#657">657</a>       getCacheProvider().remove(cacheName, key);
<a name="658" href="#658">658</a> 
<a name="659" href="#659">659</a>       afterWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object}, 1);
<a name="660" href="#660">660</a>    }
<a name="661" href="#661">661</a> 
<a name="662" href="#662">662</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="663" href="#663">663</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#save(java.lang.Object)</em>
<a name="664" href="#664">664</a> <em class="comment">    */</em>
<a name="665" href="#665">665</a>    <strong>public</strong> <strong>void</strong> save(Object object) {
<a name="666" href="#666">666</a>       Serializable id = baseGetIdValue(object);
<a name="667" href="#667">667</a>       <strong>if</strong> (id == <strong>null</strong>) {
<a name="668" href="#668">668</a>          create(object);
<a name="669" href="#669">669</a>       } <strong>else</strong> {
<a name="670" href="#670">670</a>          update(object);
<a name="671" href="#671">671</a>       }
<a name="672" href="#672">672</a>    }
<a name="673" href="#673">673</a> 
<a name="674" href="#674">674</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="675" href="#675">675</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#delete(java.lang.Object)</em>
<a name="676" href="#676">676</a> <em class="comment">    */</em>
<a name="677" href="#677">677</a>    <strong>public</strong> <strong>void</strong> delete(Object object) {
<a name="678" href="#678">678</a>       Class&lt;?> type = findClass(object);
<a name="679" href="#679">679</a>       Serializable id = baseGetIdValue(object);
<a name="680" href="#680">680</a>       delete(type, id);
<a name="681" href="#681">681</a>    }
<a name="682" href="#682">682</a> 
<a name="683" href="#683">683</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="684" href="#684">684</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#delete(java.lang.Class, java.io.Serializable)</em>
<a name="685" href="#685">685</a> <em class="comment">    */</em>
<a name="686" href="#686">686</a>    <strong>public</strong> &lt;T> <strong>boolean</strong> delete(Class&lt;T> type, Serializable id) {
<a name="687" href="#687">687</a>       checkClass(type);
<a name="688" href="#688">688</a> 
<a name="689" href="#689">689</a>       String operation = <span class="string">"delete"</span>;
<a name="690" href="#690">690</a>       beforeWrite(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>);
<a name="691" href="#691">691</a> 
<a name="692" href="#692">692</a>       <strong>boolean</strong> removed = baseDelete(type, id);
<a name="693" href="#693">693</a> 
<a name="694" href="#694">694</a>       <strong>if</strong> (removed) {
<a name="695" href="#695">695</a>          <em class="comment">// clear the search caches</em>
<a name="696" href="#696">696</a>          getCacheProvider().clear(getSearchCacheName(type));
<a name="697" href="#697">697</a>          <em class="comment">// clear this from the cache</em>
<a name="698" href="#698">698</a>          String key = id.toString();
<a name="699" href="#699">699</a>          String cacheName = getCacheName(type);
<a name="700" href="#700">700</a>          getCacheProvider().remove(cacheName, key);
<a name="701" href="#701">701</a>          
<a name="702" href="#702">702</a>          afterWrite(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>, 1);
<a name="703" href="#703">703</a>       }
<a name="704" href="#704">704</a>       <strong>return</strong> removed;
<a name="705" href="#705">705</a>    }
<a name="706" href="#706">706</a> 
<a name="707" href="#707">707</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

